package com.michale.system.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.michale.common.domain.permissions.RoleEntity;
import com.michale.common.domain.permissions.UserEntity;
import io.swagger.annotations.Api;

import java.util.List;

/**
 * @author Michale
 * @apiNote 用户管理 服务层
 */
@Api(value = "用户管理-服务类")
public interface UserService extends IService<UserEntity> {

    /**
     * 根据条件分页查询用户列表
     *
     * @param userEntity 用户信息
     * @return 用户信息集合信息
     */
    List<UserEntity> selectUserList(UserEntity userEntity);

    /**
     * 添加新用户
     *
     * @param userEntity 新用户信息
     */
    int insertUser(UserEntity userEntity);

    /**
     * 修改用户信息
     *
     * @param user 用户信息
     */
    int updateUser(UserEntity user);

    /**
     * 修改用户基本信息
     *
     * @param userEntity 用户信息
     */
    int updateUserProfile(UserEntity userEntity);

    /**
     * 修改用户头像
     * @param userName 账户名
     * @param avatar 头像地址
     */
    int updateUserAvatar(String userName,String avatar);

    /**
     * 通过用户ID查询用户
     *
     * @param userId 用户ID
     * @return 用户对象信息
     */
    UserEntity selectUserById(Long userId);

    /**
     * 注册用户信息
     *
     * @param user 用户信息
     * @return 结果
     */
    boolean registerUser(UserEntity user);

    /**
     * 根据用户名查询用户详细信息
     *
     * @param userName 用户名称
     * @return 用户详细信息
     */
    UserEntity selectUserByUserName(String userName);

    /**
     * 根据用户ID查询用户所属角色组
     *
     * @param userName 用户名
     * @return 结果
     */
    String selectUserRoleGroup(String userName);

    /**
     * 根据用户ID查询用户所属岗位组
     *
     * @param userName 用户名
     * @return 结果
     */
    String selectUserPostGroup(String userName);

    /**
     * 校验用户名称是否唯一
     *
     * @param userEntity 用户信息
     * @return 结果
     */
    String checkUserNameUnique(UserEntity userEntity);

    /**
     * 校验手机号码是否唯一
     *
     * @param userEntity 用户信息
     * @return 结果
     */
    String checkPhoneUnique(UserEntity userEntity);

    /**
     * 校验email是否唯一
     *
     * @param userEntity 用户信息
     * @return 结果
     */
    String checkEmailUnique(UserEntity userEntity);

    /**
     * 修改用户密码
     *
     * @param userEntity 被操作者的信息
     */
    int restPossWord(UserEntity userEntity);

    /**
     * 修改用户状态
     *
     * @param userEntity 修改信息
     */
    int changeStatus(UserEntity userEntity);

    /**
     * 根据与用户ID查询角色信息
     *
     * @param userId 用户ID
     * @return 角色列表
     */
    List<RoleEntity> selectRoleByUserId(Long userId);

    /**
     * 批量删除用户信息
     *
     * @param userIds 需要删除的用户ID
     * @return 结果
     */
    int deleteUserByIds(Long[] userIds);

    /**
     * 用户授权角色
     *
     * @param userId  用户ID
     * @param roleIds 角色组
     */
    void insertUserAuth(Long userId, Long[] roleIds);


    /**
     * 根据角色ID查询已授权的用户列表
     *
     * @param userEntity 用户信息
     * @return 用户信息集合信息
     */
    List<UserEntity> selectAllocatedList(UserEntity userEntity);

    /**
     * 查询未分配用户的角色列表
     *
     * @param userEntity 用户信息
     * @return 用户信息集合信息
     */
    List<UserEntity> selectUnAllocatedList(UserEntity userEntity);

    /**
     * 校验用户是否有数据权限
     *
     * @param userId 用户id
     */
    void checkUserDataScope(Long userId);

    /**
     * 判断登录者是否具有身份标识
     *
     * @param userEntity   用户信息
     * @param userClass 用户类型 (loginUser:登录者 operateUser:被操作的用户)
     */
    void checkUserIdentity(UserEntity userEntity, String userClass);

    /**
     * 检查用户是否允许操作
     *
     * @param userEntity 用户信息
     */
    void checkUserAllowed(UserEntity userEntity);

    /**
     * 记录登录信息
     *
     * @param userId 用户ID
     */
    void recordLoginInfo(Long userId);
}
